/*
 * This file is part of LuckPerms, licensed under the MIT License.
 *
 *  Copyright (c) lucko (Luck) <luck@lucko.me>
 *  Copyright (c) contributors
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy
 *  of this software and associated documentation files (the "Software"), to deal
 *  in the Software without restriction, including without limitation the rights
 *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *  copies of the Software, and to permit persons to whom the Software is
 *  furnished to do so, subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 *  SOFTWARE.
 */

package net.luckperms.api.node.types;

import net.luckperms.api.node.ChatMetaType;
import net.luckperms.api.node.NodeBuilder;
import net.luckperms.api.node.ScopedNode;

import org.checkerframework.checker.nullness.qual.NonNull;

/**
 * Represents a chat meta node. (a {@link PrefixNode} or {@link SuffixNode})
 *
 * @param <N> the node type
 * @param <B> the node builder type
 */
public interface ChatMetaNode<N extends ChatMetaNode<N, B>, B extends ChatMetaNode.Builder<N, B>> extends ScopedNode<N, B> {

    /**
     * Gets the priority.
     *
     * @return the priority
     */
    int getPriority();

    /**
     * Gets the meta value.
     *
     * @return the value
     */
    String getMetaValue();

    /**
     * Gets the type.
     *
     * @return the type
     */
    @NonNull ChatMetaType getMetaType();

    /**
     * A {@link ChatMetaNode} builder.
     *
     * @param <N> the node type
     * @param <B> the node builder type
     */
    interface Builder<N extends ChatMetaNode<N, B>, B extends ChatMetaNode.Builder<N, B>> extends NodeBuilder<N, B> {

        /**
         * Sets the priority.
         *
         * @param priority the priority
         * @return the builder
         */
        @NonNull B priority(int priority);

    }

}
